Artemis Product Availability API
Availability Response Overview
The following provides an overview of the information returned from this API and how it can help in placing a Product order. The data below includes Product Order attributes that are required to Check Available & reserve appointments and place your Product Order with PXC.
City Fibre
| Property Name | Value(s) (Example) | Value Type | Description |
|---|---|---|---|
| products | array | Array of products available | |
| productName | C-CFH-FTTP, C-CF-FTTP & C-FF-FTTP | string | Name of the available Product. ProductName is used in the Partner Appointing API to book appointments for a specific supplier and also specified in the Partner Order Management API to request a Product order |
| availability | Y or N | string | Used to determine overall Product availability |
| speeds | array | Array of Product Speeds available | |
| productSpeed | 0.5/0.5, 40/10, 80/20, 115/20, 160/30, 220/30, 330/50, 550/75 or 1000/115 | string | Array of speeds available for the specified Product. ProductSpeed is used in the Partner Appointing API to book appointments for a specific supplier and also specified in the Partner Order Management API to request the required speed for the Product order |
| codeOfConductSpeeds | array | Array for Ofcom Code of Conduct speed values for the Product | |
| TopDownstreamPeakHour | 950 | string | Typical download speed range (80th Percentile) |
| TopUpstreamPeakHour | 109 | string | Typical upload speed range (80th Percentile) |
| BottomDownstreamPeakHour | 760 | string | Typical download speed range (20th Percentile) |
| BottomUpstreamPeakHour | 87 | string | Typical upload speed range (20th Percentile) |
| MaxDownstreamQuietHour | 950 | string | The maximum speed range shows the best-case scenario speeds that a customer could potentially get at their home. It’s usually available when our network isn’t as busy. Based on off-peak times |
| MaxUpstreamQuietHour | 109 | string | The maximum speed range shows the best-case scenario speeds that a customer could potentially get at their home. It’s usually available when our network isn’t as busy. Based on off-peak times |
| MinDownstreamThreshold | 500 | string | The minimum guaranteed download speed is the minimum speed we will guarantee a customer. If their speed drops below this threshold, and we can’t fix it, then they can leave us, penalty-free |
| MinUpstreamThreshold | 86 | string | The minimum upload speed is the lowest a customer’s upload speed is likely to drop to. However, unlike download speed, it isn’t covered by a speed guarantee |
| provisioningTypes | array | Array of Provisioning Types available for the Product | |
| provisioningCommand | ProvideNew, Switch or Takeover | string | Array of provisioningCommands available for the specified Product |
| provisioningDetail | array | Array of information relating to the Provisioning Command, | |
| appointmentRequired | Y, N or R | string | Advises if a Managed Installation appointment is required with the following values: Y - Yes Managed Install Required, N - No No Managed Install Required can proceed with a Installation Type of Self Install in the Product Order or R - Recommended, Opnereach recommend booking an appointment. |
| supplierInstallType | STANDARD, EXTENDED_STANDARD or NON_STANDARD | string | City Fibre defined installation types. Values expected: STANDARD - Simplest type of install where KCI2 will be confirmed and date is unlikely to be changed by City Fibre. EXTENDED_STANDARD - Extended Standard Installation means a Standard Installation where: 1) An additional survey is required (or surveys are required) to be undertaken by City Fibre. 2) Additional route planning is required; or 3) Any wayleaves, easements or rights of way are required to be obtained over any privately owned garden(s), driveway(s) or path(s) located between the Fibre Access point and the premises (on land other than the land occupied by the relevant End User) NON-STANDARD Installation means an installation to an RFS premises that City Fibre determines is not capable of being connected through the completion of the Standard Installation process or the Extended Standard installation process, such determination to be made on or before the date on which such premises is first declared RFS, whichever is earlier |
| available | Y or N | string | Used to determine overall the specific Provisioning Command availability. Values expected: Y - Yes or N - No |
| earliestAvailable | 09/09/2024 | string | Earliest availability date the Supplier has indicated the service can be installed or activated. This date should be used when checking for appointment availability |
| noAvailabilityCode | PROPERTY_AT_CAPACITY | string | Reasons for why a specific Product isn't available. Please refer to the noAvailabilityCodes page for a the full list. |
| existingLine | object | Object containing information about any Existing Lines or ONTs | |
| opticalNetworkTerminator | array | Array of information relating to ONT installed | |
| id | ALCLFD431121 | string | Serial number of the supplier ONT Reference |
| ontCharacteristic | array | Array of Characteristics for the ONT | |
| ontReference | ONT0076229829 | string | Supplier Optical Network Terminator (ONT) reference. Used to identify an ONT at a specific address |
| port | array | Array of Port information against the activate ONT | |
| portCharacteristic | array | Array of Port Characteristics | |
| portNumber | 1 | string | Port Number(s) associated to the ONT reference. ONT's can be single port or multiport. This will be identified in the Product Availability response |
| portStatus | Working or Spare | string | Status of the ONT Port. Ports can be in the following states: Working or Spare |
Openreach
| Property Name | Value(s) (Example) | Value Type | Description |
|---|---|---|---|
| products | array | Array of products available | |
| productName | C-OR-FTTP or C-OR-SOGEA | string | Name of the available Product. ProductName is used in the Partner Appointing API to book appointments for a specific supplier and also specified in the Partner Order Management API to request a Product order |
| availability | Y or N | string | Used to determine overall Product availability |
| speeds | array | Array of Product Speeds available | |
| productSpeed | 0.5/0.5, 40/10, 80/20, 115/20, 160/30, 220/30, 330/50, 550/75 or 1000/115 | string | Array of speeds available for the specified Product. ProductSpeed is used in the Partner Appointing API to book appointments for a specific supplier and also specified in the Partner Order Management API to request the required speed for the Product order |
| codeOfConductSpeeds | array | Array for Ofcom Code of Conduct speed values for the Product | |
| TopDownstreamPeakHour | 950 | string | Typical download speed range (80th Percentile) |
| TopUpstreamPeakHour | 109 | string | Typical upload speed range (80th Percentile) |
| BottomDownstreamPeakHour | 760 | string | Typical download speed range (20th Percentile) |
| BottomUpstreamPeakHour | 87 | string | Typical upload speed range (20th Percentile) |
| MaxDownstreamQuietHour | 950 | string | The maximum speed range shows the best-case scenario speeds that a customer could potentially get at their home. It’s usually available when our network isn’t as busy. Based on off-peak times |
| MaxUpstreamQuietHour | 109 | string | The maximum speed range shows the best-case scenario speeds that a customer could potentially get at their home. It’s usually available when our network isn’t as busy. Based on off-peak times |
| MinDownstreamThreshold | 500 | string | The minimum guaranteed download speed is the minimum speed we will guarantee a customer. If their speed drops below this threshold, and we can’t fix it, then they can leave us, penalty-free |
| MinUpstreamThreshold | 86 | string | The minimum upload speed is the lowest a customer’s upload speed is likely to drop to. However, unlike download speed, it isn’t covered by a speed guarantee |
| provisioningTypes | array | Array of Provisioning Types available for the Product | |
| provisioningCommand | ProvideNew, Switch, Takeover, Restart, SwitchToNew, SwitchToStop, ReplaceToNew or ReplaceToStop | string | Array of provisioningCommands available for the specified Product |
| provisioningDetail | array | Array of information relating to the Provisioning Command | |
| appointmentRequired | Y, N or R | string | Advises if a Managed Installation appointment is required with the following values: Y - Yes Managed Install Required, N - No No Managed Install Required can proceed with a Installation Type of Self Install in the Product Order or R - A Managed Install is Recommended but not necessary. |
| supplierInstallType | 1 Stage or KCI2 Assure | string | Supplier FTTP installation type. Expected values: 1 Stage - Simplest type of install where KCI2 will be confirmed and date is unlikely to be changed by Openreach or KCI2 Assure - KCI2 will not be confirmed until an initial external site survey has taken place. Once this is confirmed at KCI2 the install date it is likely to remain unchanged |
| available | Y, N, P or W | string | Used to determine overall the specific Provisioning Command availability. Values expected: Y - Yes, N - No, P - Possible. Proceed with a secondary Line Availability or Reference Availability to determine if the Provisioning Command is available or W - Capacity Waiters |
| earliestAvailable | 09/09/2024 | string | Earliest availability date the Supplier has indicated the service can be installed or activated. This date should be used when checking for appointment availability |
| l2sid | BAAMPW | string | ID of the local Switch PXC interconnect to the Supplier |
| noAvailabilityCode | SUPPLIER_INFRASTRUCTURE_NOT_AVAILABLE | string | Reasons for why a specific Product isn't available. Please refer to the noAvailabilityCodes page for a the full list |
| existingLine | object | Object containing information about any Existing Access Lines or ONTs | |
| accessLine | array | Array of information relating to Access Line ID installed | |
| id | OOF5363567O3 | string | Openreach Access Line ID of the live Product |
| lineCharacteristic | array | Array of Characteristics relating to the Access Line ID | |
| partialDN | 74 | string | Last 2 digits of the CLI associated to the Access Line ID |
| lineStatus | Working or Stopped | string | Status of the Openreach Access Line ID. This can show the following stated: Working or Stopped |
| productType | CBS | string | Product associated to the Access Line ID. Defined values: CBS (SOGEA), MPF (LLU Based Single Copper Line), PSTN Single Line (WLR Line) |
| opticalNetworkTerminator | array | Array of information relating to ONT installed | |
| id | ALCLFD431121 | string | Serial number of the supplier ONT Reference |
| ontCharacteristic | array | Array of Characteristics for the ONT | |
| ontReference | ONT0076229829 | string | Supplier Optical Network Terminator (ONT) reference. Used to identify an ONT at a specific address |
| port | array | Array of Port information against the activate ONT | |
| portCharacteristic | array | Array of Port Characteristics | |
| portNumber | 1 | string | Port Number(s) associated to the ONT reference. ONT's can be single port or multiport. This will be identified in the Product Availability response |
| portStatus | Working or Spare | string | Status of the ONT Port. Ports can be in the following states: Working or Spare |